Add nullability annotations to io.reactivex.annotations interfaces.#5023
Merged
akarnokd merged 1 commit intoReactiveX:2.xfrom Jan 27, 2017
Merged
Conversation
929f0fb to
e588d36
Compare
Current coverage is 95.63% (diff: 100%)@@ 2.x #5023 diff @@
==========================================
Files 609 609
Lines 39379 39379
Methods 0 0
Messages 0 0
Branches 6025 6025
==========================================
+ Hits 37616 37659 +43
+ Misses 764 747 -17
+ Partials 999 973 -26
|
Member
|
/cc @dlew, @vanniktech |
vanniktech
approved these changes
Jan 27, 2017
Collaborator
vanniktech
left a comment
There was a problem hiding this comment.
Looks good. I'd say this is for a first try just enough. Would not annotate more.
|
This looks fine to me as a start. |
Member
|
Great! |
This was referenced Feb 2, 2017
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
(Addresses #4876)
This pull request annotates everything in the
io.reactivex.annotationspackage with a new@NonNullannotation defined in RxJava. This doesn’t annotate everything, but I think it’s a good start.In particular, when migrating a large codebase of RxJava 1.x code to 2.x, catching null returns in these interfaces was very difficult. At best, it’s noticed while migrating, otherwise it’s up to unit tests or a production crash to catch these.
With these new annotations, you get much better IDE support (once you tell IntelliJ about the new annotation):

^ in this example,
getPhoneNumber()is marked as@NullableIn addition, support for this annotation can easily be added to static analysis tools like Infer, checker, or any other popular tool.
Open Questions
@NonNullannotation needs JavaDoc - I’m planning on following up with whatever is in existing NonNull annotations floating around unless anyone thinks otherwise.